/*
 * 
 * Copyright 2011 visual-analysis-of-cancer.
 * This file is part of visual-analysis-of-cancer.
 * 
 * visual-analysis-of-cancer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * visual-analysis-of-cancer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with kOSMik.  If not, see <http://www.gnu.org/licenses/>.
 *  
 * visual-analysis-of-cancer:
 * An tool to analye the WHO and GLOBOCAN cancer data.
 * http://code.google.com/p/visual-analysis-of-cancer/
 * 
 * 
 * 
 * Authors: Erik Sniegula, Johannes Dahlke
 * 
 * Module:  Programming in Processing for Visual Analytics
 * Group:   20
 * 
 * Created: Aug. 2011
 * Version: 1.0
 *
 */
 




package de.fuberlin.processing.who.cancer.interaction;

import java.util.Collection;
import java.util.Observer;


public interface LocationModifier {

	/**
	 * addLocation fügt eine Location zur Auswahl hinzu. Jedoch nur, wenn diese
	 * noch nicht in der Auswahl enthalten ist. Wird die Location hinzugefügt,
	 * dann werden alle Observer benachrichtigt. Als Zusatzinformation (Parameter)
	 * wird eine ausschließlich das neu hinzugefügte Element enthaltende Menge
	 * mitgesendet.
	 * 
	 * @param locationId
	 *          die ID der Location, die hinzugefügt werden soll.
	 * 
	 * @return true, wenn die Location hinzugefügt wurde. Sonst false.
	 */
	boolean addLocation( Integer locationId);


	/**
	 * removeLocation entfernt eine Location aus der Auswahl. Jedoch nur, wenn
	 * diese auch darin enthalten ist. Wird die Location entfernt, so werden alle
	 * Observer benachrichtigt. Als Zusatzinformation (Parameter) wird eine
	 * ausschließlich das neu entfernte Element enthaltende Menge mitgesendet.
	 * 
	 * @param locationId
	 *          die ID der Location, die entfernt werden soll.
	 * 
	 * @return true, wenn die Location entfernt wurde. Sonst false.
	 */
	boolean removeLocation( int locationId);


	/**
	 * addLocations fügt eine Menge von Locations zur Auswahl hinzu. Dabei Auswahl
	 * enthalten ist. Es werden nur die Locations hinzugefügt, die noch nicht in
	 * der Auswahl enthalten sind. Werden Locations hinzugefügt, dann werden alle
	 * Observer benachrichtigt. Als Zusatzinformation (Parameter) wird eine die
	 * neu hinzugefügten Elemente enthaltende Menge mitgesendet.
	 * 
	 * @param locations
	 *          die Menge der hinzuzufügenden Locations.
	 * 
	 * @return true, wenn eine Untermenge der übergebenen Locations zur Auswahl
	 *         hinzugefügt wurden. Sonst false.
	 */
	boolean addLocations( Collection<Integer> locations);


	/**
	 * setLocations setzt die Auswahl gleich der übergebenen Menge von Locations
	 * Alle Observer werden benacrichtigt. Als Zusatzinformation (Parameter) wird
	 * die Menge der zur neuen Auswahl gehörenden Locations mitgesendet.
	 * 
	 * @param locations
	 *          die Menge der neuen Auswahl an Locations.
	 */
	void setLocations( Collection<Integer> locations);


	/**
	 * getLocations liefert die momentane Auswahl.
	 * 
	 * @return eine Kopie der intern geführten Kollektion der Auswahl.
	 */
	Collection<Integer> getLocations();


	/**
	 * Löscht die Auswahl. Alle Observer werden benachrichtigt.
	 */
	void clear();


	/**
	 * Sendet Broadcast an alle Observer. Als Zusatzinformation (Parameter) wird
	 * die aktuelle Auswahl mitgesendet.
	 */
	void update();
	
	
	/**
	 * Fügt einen neuen Beobachter  hinzu.
	 * 
	 * @param observer
	 */
	void addObserver( Observer observer);

}
